Fix: Use only one blank line to separate sections or paragraphs #23871
Conversation
|
Hello @alexander-ponomaroff! Thanks for submitting the PR.
|
Original List of Errors - 127 errorspandas.read_table Current List of Errors - 58 errorspandas.read_table |
Codecov Report
@@ Coverage Diff @@
## master #23871 +/- ##
=======================================
Coverage 92.29% 92.29%
=======================================
Files 161 161
Lines 51497 51497
=======================================
Hits 47530 47530
Misses 3967 3967
Continue to review full report at Codecov.
|
|
Thanks for taking care of those @alexander-ponomaroff I kept the issue open, as you mention that there are still 58 errors to fix. Was there any impediment to fix those, or there were just too many for a single PR? |
|
@datapythonista No problem! The other errors were a bit problematic. Some of them didn't show the line number and file, and some showed error in the actual code and not the docs. I will further look into those to see if I can figure out what needs to be fixed. |
|
Yes, unfortunately the introspection to detect where a function is defined doesn't work well if the function is created in a tricky way (and we do that somehow often for better code organization and not repeating code in pandas). One option (tricky but effective) is check the docstring with for example The good news is that I think many of the pending one in your list reuse docstring, so there are probably one third of the number in the list that need to fixed. |
|
@datapythonista I will keep this in mind for the future, thanks! |
By running
./scripts/validate_docstrings.py --errors=GL03 --format=azure, I was able to get the list of GL03 errors with files and line numbers where these errors occurred.I fixed a big portion of these issues so far.
@datapythonista
git diff upstream/master -u -- "*.py" | flake8 --diff